口座直結決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

BankDirectRegist 口座登録依頼

口座登録に必要な事項を送信し、以降の口座確認に必要なトランザクションIDを受け取ります。

リクエスト

SiteID	siteID	必須半角英数13桁サイトID
SitePass	sitePass	必須半角英数64桁サイトパスワード
ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
MemberID	memberID	必須半角英数記号60桁会員ID 会員登録済みの場合はその会員IDに対し口座登録を行います。会員IDが未登録の場合は新規に会員を登録します。
MemberName	memberName	全半角255桁会員名登録済みの会員IDが指定された場合は無視されます。
RetURL	retURL	必須半角英数記号256桁戻り先URL 加盟店様が当サービスからの口座登録結果を受信するための結果受信URLを設定します。金融機関画面でお客様が登録手続きを完了された際に、指定されたURLに結果をリダイレクト経由で送信します。
BankCode	bankCode	必須半角数字4桁固定金融機関コード
AccountNameLast	accountNameLast	必須全角60バイト口座名義人（姓　カナ）全角英数字カナおよび以下の記号が入力可能です。￥，．（）ー－／＊「」＄＋＆全角スペース（ゆうちょ銀行以外）￥，．（）ー－／「」＄＋全角スペース（ゆうちょ銀行）
AccountNameFirst	accountNameFirst	必須全角60バイト口座名義人（名　カナ）全角英数字カナおよび以下の記号が入力可能です。￥，．（）ー－／＊「」＄＋＆全角スペース（ゆうちょ銀行以外）￥，．（）ー－／「」＄＋全角スペース（ゆうちょ銀行）
DateOfBirth	dateOfBirth	半角数字8桁固定生年月日 YYYYMMDD形式以下の金融機関の場合必須です。その他の金融機関では無視されます。北海道銀行横浜銀行北陸銀行広島銀行福岡銀行十八親和銀行沖縄銀行熊本銀行

URL

/payment/BankDirectRegist.json

リクエストパラメータ

{
  "siteID": "tsite11223344",
  "sitePass": "PASSWORD",
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "memberID": "sampleMemberID",
  "retURL": "https://example.com/xxxxx",
  "bankCode": "9999",
  "accountNameLast": "テスト",
  "accountNameFirst": "タロウ"
}

URL

/payment/BankDirectRegist.idPass

リクエストパラメータ

SiteID=tsite11223344&SitePass=PASSWORD&ShopID=tshop11223344&ShopPass=PASSWORD&MemberID=sampleMemberID&RetURL=https://example.com/xxxxx&BankCode=9999&AccountNameLast=テスト&AccountNameFirst=タロウ

レスポンス

正常

TranID	tranID	必須半角英数40桁固定トランザクションID
Token	token	必須半角英数64桁固定トークン
StartUrl	startUrl	必須半角英数記号256桁開始URL

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "tranID": "79f5d7dab835400fb62508d8cabeb44920220711",
  "token": "f667442d2023f2d9132dbee136c2a2a26c2cc17d7539be9fba733d86eeab1910",
  "startUrl": "https://example.com/xxxxx"
}

レスポンスパラメータ：正常系

TranID=79f5d7dab835400fb62508d8cabeb44920220711&Token=f667442d2023f2d9132dbee136c2a2a26c2cc17d7539be9fba733d86eeab1910&StartUrl=https://example.com/xxxxx

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

BankDirectStart 口座登録手続き開始

お客様を口座情報確認画面へ誘導します。

リクエスト

TranID		必須半角英数40桁固定トランザクションID
Token		必須半角英数64桁固定トークン

URL

/payment/BankDirectStart.idPass

リクエストパラメータ

TranID=79f5d7dab835400fb62508d8cabeb44920220711&Token=f667442d2023f2d9132dbee136c2a2a26c2cc17d7539be9fba733d86eeab1910

リクエストパラメータ

</html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	</head>
	<body OnLoad='OnLoadEvent();'>
		<form name="BankDirectStartCall" action="{口座登録依頼のレスポンスで返却した開始URL}" method="POST">
			<noscript>
				<br>
				<br>
				</div>
					<h2>口座情報確認画面へ遷移します。</h2>
					<input type="submit" value="続行">
				</div>
			</noscript>
			<input type="hidden" name="TranID" value="{TranID}">
			<input type="hidden" name="Token" value="{Token}">
		</form>
		<script>
			<!--
			function OnLoadEvent() {
				document.BankDirectStartCall.submit();
			}
			//-->
		</script>
	</body>
</html>

リダイレクト後、お客様は口座情報確認画面へ遷移します。

口座登録結果受信

金融機関での口座登録手続きが完了した後、口座登録依頼にて指定された戻り先URLに結果を返却します。
この結果はブラウザ経由で連携されるため、ユーザの操作方法によっては完了したにもかかわらず、加盟店様に返却されないことがあります。
その際はショップ管理画面、結果通知、口座情報照会にて状態をご確認ください。

レスポンス

正常

TranID		必須半角英数40桁固定トランザクションID
SiteID		必須半角英数13桁サイトID
MemberID		必須半角英数60桁会員ID
Status		必須現状態 REGISTER：登録完了 FAIL：登録失敗
BankCode		半角数字4桁固定金融機関コード登録失敗時は返却されません。
BranchCode		半角数字3桁固定支店コードゆうちょ銀行の場合、預金記号の2-4桁目となります。登録失敗時は返却されません。
AccountType		半角数字1桁固定預金区分 1：普通　2：当座登録失敗時は返却されません。
AccountNumber		半角数字7桁固定口座番号口座番号をサイト設定の「口座番号マスクレベル」により、マスクします。 ※例：***567 ゆうちょ銀行の場合、預金番号となります。登録失敗時は返却されません。
AccountName		半角60桁口座名義人カナ登録失敗時は返却されません。
CheckString		半角英数64桁固定改ざんチェック文字列 TranID、SiteID、MemberID、Statusを連結しSHA256ハッシュした値を返却します。登録失敗時は返却されません。
ErrCode		半角英数3桁固定エラーコード登録失敗時のみ返却されます。
ErrDetail		半角英数9桁固定エラー詳細コード登録失敗時のみ返却されます。

BankDirectEnd 口座情報削除

登録済みの口座を解除します。

リクエスト

SiteID	siteID	必須半角英数13桁サイトID
SitePass	sitePass	必須半角英数64桁サイトパスワード
MemberID	memberID	必須半角英数60桁会員ID

URL

/payment/BankDirectEnd.json

リクエストパラメータ

{
  "siteID": "tsite11223344",
  "sitePass": "PASSWORD",
  "memberID": "sampleMemberID"
}

URL

/payment/BankDirectEnd.idPass

リクエストパラメータ

SiteID=tsite11223344&SitePass=PASSWORD&MemberID=sampleMemberID

レスポンス

正常

Status		status		必須半角英字 3桁現状態対象会員の口座状態を返却します。・END：登録解除

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "status": "END"
}

レスポンスパラメータ：正常系

Status=END

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchBankDirect 口座情報照会

有効な状態の登録済み口座情報を取得します。

リクエスト

SiteID	siteID	必須半角英数13桁サイトID
SitePass	sitePass	必須半角英数64桁サイトパスワード
MemberID	memberID	必須半角英数60桁会員ID

URL

/payment/SearchBankDirect.json

リクエストパラメータ

{
  "siteID": "tsite11223344",
  "sitePass": "PASSWORD",
  "memberID": "sampleMemberID"
}

URL

/payment/SearchBankDirect.idPass

リクエストパラメータ

SiteID=tsite11223344&SitePass=PASSWORD&MemberID=sampleMemberID

レスポンス

正常

BankCode	bankCode	必須半角数字4桁固定金融機関コード
BankName	bankName	全角50桁金融機関名
BranchCode	branchCode	必須半角数字3桁固定支店コードゆうちょ銀行の場合、預金記号の2-4桁目となります。
BranchName	branchName	全角50桁支店名
AccountType	accountType	必須半角数字1桁固定預金区分 1：普通　2：当座
AccountNumber	accountNumber	必須半角数字7桁固定口座番号口座番号をサイト設定の「口座番号マスクレベル」により、マスクします。 ※例：***567 ゆうちょ銀行の場合、預金番号となります。
AccountName	accountName	必須半角60桁口座名義人カナ

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "bankCode": "9999",
  "bankName": "サンプル銀行",
  "branchCode": "001",
  "branchName": "本店",
  "accountType": "1",
  "accountNumber": "****567",
  "accountName": "ﾃｽﾄ ﾀﾛｳ"
}

レスポンスパラメータ：正常系

BankCode=9999&BankName=サンプル銀行&BranchCode=001&BranchName=本店&AccountType=1&AccountNumber=****567&AccountName=ﾃｽﾄ ﾀﾛｳ

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchAvailableBankDirect 利用可能金融機関照会

利用可能な金融機関コードの一覧を取得します。

リクエスト

ShopID		shopID		必須半角英数13桁ショップID
ShopPass		shopPass		必須半角英数64桁ショップパスワード

URL

/payment/SearchAvailableBankDirect.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD"
}

URL

/payment/SearchAvailableBankDirect.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD

レスポンス

正常

BankCode		bankCode		必須半角数字4桁固定金融機関コード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

[
    {
        "bankCode": "9998"
    },
    {
        "bankCode": "9999"
    }
}

レスポンスパラメータ：正常系

BankCode=9998|9999

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

EntryTranBankDirect 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
SiteID	siteID	必須半角英数13桁サイトID
SitePass	sitePass	必須半角英数64桁サイトパスワード
MemberID	memberID	必須半角英数60桁会員ID
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料

URL

/payment/EntryTranBankDirect.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "siteID": "tsite11223344",
  "sitePass": "PASSWORD",
  "memberID": "sampleMemberID",
  "orderID": "ORDER0000001",
  "amount": "1000"
}

URL

/payment/EntryTranBankDirect.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&SiteID=tsite11223344&SitePass=PASSWORD&MemberID=sampleMemberID&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranBankDirect 決済実行

取引登録した取引に対して決済を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
Remarks	remarks	半角9桁通帳印字加盟店名以下の金融機関では無視されます。北海道銀行横浜銀行北陸銀行広島銀行福岡銀行十八親和銀行沖縄銀行熊本銀行ゆうちょ銀行

URL

/payment/ExecTranBankDirect.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}

URL

/payment/ExecTranBankDirect.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須半角英字7桁現状態取引の状態を返却します。 CAPTURE：決済成功
TranDate	tranDate	必須半角数字14桁固定決済日付 YYYYMMDDHHmmss形式
CheckString	checkString	必須半角英数64桁固定改ざんチェック文字列 OrderID、AccessID、ShopID、ShopPass、TranDate、Statusを連結しSHA256ハッシュした値を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CAPTURE",
  "tranDate": "20220901011021",
  "checkString": "5ea87cf889c41efbdcde2d57661af9b7e1210581af4918574ff9883d9787a2eb"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CAPTURE&TranDate=20220901011021&CheckString=5ea87cf889c41efbdcde2d57661af9b7e1210581af4918574ff9883d9787a2eb

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

BankDirectCancel 決済取消

決済の取消を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
CancelAmount	cancelAmount	必須半角数字7桁キャンセル利用金額決済時の利用金額と一致している必要があります。
CancelTax	cancelTax	半角数字7桁キャンセル税送料決済時の税送料と一致している必要があります。

URL

/payment/BankDirectCancel.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "1000"
}

URL

/payment/BankDirectCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須半角英字7桁現状態取引の状態を返却します。 CANCEL：キャンセル
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料
CancelAmount	cancelAmount	必須半角数字7桁キャンセル利用金額
CancelTax	cancelTax	必須半角数字7桁キャンセル税送料

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CANCEL",
  "amount": "0",
  "tax": "0",
  "cancelAmount": "1000",
  "cancelTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeBankDirect/SearchTradeMulti 取引情報照会

対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
PayType	payType	半角数字2桁決済方法 SearchTradeMultiをご利用の際は「53」を指定してください。 SearchTradeBankDirectをご利用の際は設定不要です。

URL

/payment/SearchTradeBankDirect.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}

URL：SearchTradeBankDirectの場合

/payment/SearchTradeBankDirect.idPass

URL：SearchTradeMultiの場合

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001

レスポンス

正常

Status	status	必須半角英字11桁現状態 UNPROCESSED：未決済 CAPTURE：決済成功 CANCEL：キャンセル
ProcessDate	processDate	必須半角数字14桁固定処理日時 YYYYMMDDHHmmss形式
JobCd	jobCd	必須半角英字7桁処理区分 CAPTURE：決済成功 CANCEL：キャンセル
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
PayType	payType	必須半角数字2桁固定決済方法 53：口座直結決済
BankCode	bankCode	必須半角数字4桁固定金融機関コード
BranchCode	branchCode	必須半角数字3桁固定支店コードゆうちょ銀行の場合、預金記号の2-4桁目となります。
AccountType	accountType	必須半角数字1桁固定預金区分 1：普通　2：当座
AccountNumber	accountNumber	必須半角数字7桁固定口座番号口座番号をサイト設定の「口座番号マスクレベル」により、マスクします。 ※例：***567 ゆうちょ銀行の場合、預金番号となります。
AccountName	accountName	必須半角60桁口座名義人カナ

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "status": "CAPTURE",
  "processDate": "20220901011021",
  "jobCd": "CAPTURE",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "amount": "1000",
  "tax": "0",
  "payType": "53",
  "bankCode": "0002",
  "branchCode": "001",
  "accountType": "1",
  "accountNumber": "****567",
  "accountName": "ﾃｽﾄ ﾀﾛｳ"
}

レスポンスパラメータ：正常系

Status=CAPTURE&ProcessDate=20220901011021&JobCd=CAPTURE&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&PayType=53&BankCode=9999&BranchCode=001&AccountType=1&AccountNumber=****567&AccountName=ﾃｽﾄ ﾀﾛｳ

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001